home *** CD-ROM | disk | FTP | other *** search
/ Computer Music Interactif 11 / cd.iso / pc / PC / demos / hypercieve / Insigma Demonstrations / walk / Present.txt < prev    next >
Encoding:
Text File  |  1999-10-05  |  1.9 KB  |  65 lines
  1. $Id: Present.txt,v 1.3 1998/11/25 15:46:48 dj Exp $
  2.  
  3. Hyperceive plugin documentation
  4. ===============================
  5.  
  6. Name:        Present
  7. Purpose:    Simple presentation system
  8. Author:        James Aylett
  9.  
  10. The Present applet provides a simple slide-show of presentation pages. The
  11. pages are images, and are displayed between a foreground and a background
  12. image. Action hotspots may be defined on the foreground layer.
  13.  
  14.  
  15. Parameters
  16. ----------
  17.  
  18.     backgroundcolour    as r,g,b (default is black)
  19.     backgroundimage        <url>
  20.     foregroundimage        <url>
  21.     <p>image        the image for the current page
  22.     <p>sleep        time to sleep before starting
  23.                   the next page
  24.     <p>x, <p>y        offsets into image to display
  25.     <p>shuntx        x speed in pixels/clock to
  26.                   shunt the previous image
  27.     <p>shunty        y speed as above
  28.     <p>shuntbump        if present, bump shunt not smooth
  29.     <p>shuntclock        clock in milliseconds for the
  30.                   shunt
  31.     <p>shuntsound        URL of a sound file to loop
  32.                   during the shunt
  33.             
  34.     hotspot<n>url        URL for hotspot number n.
  35.     hotspot<n>target
  36.     hotspot<n>x0        position of hotspot number
  37.     hotspot<n>y0          n, defined as a rectangle
  38.     hotspot<n>x1
  39.     hotspot<n>y1
  40.     hotspot<n>sound        URL of a sound file to play
  41.                   when the hotspot is
  42.                   clicked on
  43.  
  44. <p> is a page number, starting from 1. <n> starts from 1.
  45.  
  46. If the sleep is -1, Present will enter a holding state at that point, waiting
  47. until Hyperceive 'plays' it. If not, it will wait for that time before
  48. proceeding on to the next page. The Hyperceive event c_play will move it on
  49. to the next page; c_playarg n will move it to page n.
  50.  
  51. During the holding state, it will report itself as loaded and ready to
  52. proceed to Hyperceive; at all other times it will report 'still loading'.
  53.  
  54.  
  55. Operational flow
  56. ----------------
  57.  
  58. The sequence of events is therefore:
  59.  
  60. REPEAT (pages):
  61.     shunt previous page off with new one
  62.     prepare next page, if necessary
  63.     wait for '<p>sleep', or wait for play / playarg event from Hyperceive
  64. UNTIL last page displayed
  65.